<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_sditxss: xsdi_menu.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_sditxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xsdi__menu_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xsdi_menu.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the main header file for the Xilinx Menu implementation as used in the SDI example design. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date       Changes
</p>
<hr/>
<p>
1.0     ssh      07/05/2018 Initial version
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_sdi___menu.html">XSdi_Menu</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The SDI menu instance data.  <a href="struct_x_sdi___menu.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a43b3cc97eb44a6a594690646865302af"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsdi__menu_8h.html#a43b3cc97eb44a6a594690646865302af">XSDI_MENU_H_</a></td></tr>
<tr class="memdesc:a43b3cc97eb44a6a594690646865302af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#a43b3cc97eb44a6a594690646865302af">More...</a><br/></td></tr>
<tr class="separator:a43b3cc97eb44a6a594690646865302af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0fb65531d872bdaa97a3c0cb630e5c6a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsdi__menu_8h.html#a0fb65531d872bdaa97a3c0cb630e5c6a">XSdi_MenuType</a> </td></tr>
<tr class="memdesc:a0fb65531d872bdaa97a3c0cb630e5c6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The SDI menu types.  <a href="xsdi__menu_8h.html#a0fb65531d872bdaa97a3c0cb630e5c6a">More...</a><br/></td></tr>
<tr class="separator:a0fb65531d872bdaa97a3c0cb630e5c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac7968c537f9754babeb38483eb3bad49"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsdi__menu_8h.html#ac7968c537f9754babeb38483eb3bad49">XSdi_MenuInitialize</a> (<a class="el" href="struct_x_sdi___menu.html">XSdi_Menu</a> *InstancePtr, u32 UartBaseAddress)</td></tr>
<tr class="memdesc:ac7968c537f9754babeb38483eb3bad49"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function takes care of the SDI menu initialization.  <a href="#ac7968c537f9754babeb38483eb3bad49">More...</a><br/></td></tr>
<tr class="separator:ac7968c537f9754babeb38483eb3bad49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac74505e03761810c2a379695163ad041"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsdi__menu_8h.html#ac74505e03761810c2a379695163ad041">XSdi_MenuProcess</a> (<a class="el" href="struct_x_sdi___menu.html">XSdi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:ac74505e03761810c2a379695163ad041"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to trigger the SDI menu statemachine.  <a href="#ac74505e03761810c2a379695163ad041">More...</a><br/></td></tr>
<tr class="separator:ac74505e03761810c2a379695163ad041"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a43b3cc97eb44a6a594690646865302af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XSDI_MENU_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a0fb65531d872bdaa97a3c0cb630e5c6a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xsdi__menu_8h.html#a0fb65531d872bdaa97a3c0cb630e5c6a">XSdi_MenuType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The SDI menu types. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac7968c537f9754babeb38483eb3bad49"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XSdi_MenuInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_sdi___menu.html">XSdi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>UartBaseAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function takes care of the SDI menu initialization. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_sdi___menu.html" title="The SDI menu instance data. ">XSdi_Menu</a> instance. </td></tr>
    <tr><td class="paramname">UartBaseAddress</td><td>points to the base address of PS uart.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>Referenced by <a class="el" href="xsdi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ac74505e03761810c2a379695163ad041"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XSdi_MenuProcess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_sdi___menu.html">XSdi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to trigger the SDI menu statemachine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_sdi___menu.html" title="The SDI menu instance data. ">XSdi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>Referenced by <a class="el" href="xsdi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
